Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(starlette): Allow to configure status codes to report to Sentry #3008

Merged
merged 11 commits into from
Jun 6, 2024

Conversation

sentrivana
Copy link
Contributor

@sentrivana sentrivana commented Apr 24, 2024

Until now, our server framework integrations used to only report status codes in the 5xx range to Sentry. The reasoning was that the client should report client side errors.

However, not everyone has the client instrumented or wants to have it instrumented, and they might want to have the client range 4xx reported to Sentry by the server integration.

Docs PR: getsentry/sentry-docs#10282

Closes #2825

Failed request status codes

In this PR, we're adding a new option to Starlette and FastAPI called failed_request_status_codes (naming based on develop docs) to make it possible to configure which status codes should be reported to Sentry. If no failed_request_status_codes are provided, we default to the 5xx range.

failed_request_status_codes is a list of status code ranges, where a status code range is one of:

  • single number
  • a sequence with a __contains__ method (so that we can check whether a code is in the sequence with in)

The following are examples of valid failed_request_status_codes:

  • [500]
  • [403, range(500, 599)]
  • [{500, 501, 502, 503}]

Follow up


General Notes

Thank you for contributing to sentry-python!

Please add tests to validate your changes, and lint your code using tox -e linters.

Running the test suite on your PR might require maintainer approval. Some tests (AWS Lambda) additionally require a maintainer to add a special label to run and will fail if the label is not present.

For maintainers

Sensitive test suites require maintainer review to ensure that tests do not compromise our secrets. This review must be repeated after any code revisions.

Before running sensitive test suites, please carefully check the PR. Then, apply the Trigger: tests using secrets label. The label will be removed after any code changes to enforce our policy requiring maintainers to review all code revisions before running sensitive tests.

Base automatically changed from sentry-sdk-2.0 to master April 25, 2024 09:13
@sentrivana sentrivana self-assigned this Apr 29, 2024
@sentrivana sentrivana changed the title feat(integrations): Allow to configure status codes to report to Sentry feat(starlette): Allow to configure status codes to report to Sentry Jun 5, 2024
@sentrivana sentrivana marked this pull request as ready for review June 5, 2024 09:53
Copy link
Member

@antonpirker antonpirker left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very Nice! 💯

@sentrivana sentrivana merged commit 9227968 into master Jun 6, 2024
111 checks passed
@sentrivana sentrivana deleted the ivana/2.0/configure-status-codes branch June 6, 2024 09:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Enable configuration of reported status codes for FastAPI/Starlette HTTPExceptions
2 participants